package com.wlb365.doc.bean;

import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;
import org.apache.commons.lang.StringUtils;

import java.util.List;

/**
 * <p>
 * 概述：参数定义
 * </p>
 *
 * @author zwh
 * @version 1.0
 * @copyRight 北京微利宝信息技术有限公司  All right reserved.
 * @date 2020/3/21
 */
@Data
public class DocParameter {
    private String module;
    private String name;
    /**
     * 参数类型
     */
    private String type;
    /**
     * 最大长度
     */
    private String maxLength = "-";
    /**
     * 是否必填
     */
    private boolean required;
    /**
     * 描述
     */
    private String description;
    /**
     * 示例值
     */
    private String example = "";

    @JSONField(name = "x-example")
    private String x_example = "";

    private List<DocParameter> refs;

    public String getParamExample() {
        return StringUtils.isBlank(example) ? x_example : example;
    }
}
